home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / programming / libraries / splib43d.lha / superplay-lib_DEV / Programmers / Example_SPObjects / ST / ST.doc < prev    next >
Encoding:
Text File  |  1994-12-14  |  6.4 KB  |  183 lines
  1.  
  2.   ST.svobject
  3.  
  4.   © 1994 by Andreas R. Kleinert.
  5.  
  6.   FREEWARE. All rights reserved.
  7.  
  8.   Version      : 2.2
  9.   Release Date : 11.12.1994
  10.  
  11.  
  12.   Description
  13.   ~~~~~~~~~~~
  14.   ST.svobject is an external Library-Module for the superplay.library V1+.
  15.  
  16.   It supports reading of ST Modules (SoundTracker V2.4+, ProTracker V2.2a,
  17.   NoiseTracker and compatible Modules).
  18.  
  19.  
  20.   Requirements
  21.   ~~~~~~~~~~~~
  22.   - OS V2.04+ (V37)+ and its libraries
  23.   - for reading of packed modules, either xpkmaster.library or
  24.     powerpacker.library is needed :
  25.  
  26.     Packer      needed Libraries
  27.     XPK            xpkmaster.library V2+, speficic xpk-compressor libraries
  28.     PP20        a) xpkmaster.library V2+, powerpacker.library V33+
  29.                 b) _only_ powerpacker.library V33+
  30.     <None>      <no special libraries are needed, but they will simply pass
  31.                  through unpacked data modules>
  32.  
  33.  
  34.   Remarks
  35.   ~~~~~~~
  36.    - As with other Players, the filename of the Module has to begin
  37.      or end with the prefix/entension "MOD" ("MOD.module" or "module.MOD")
  38.    - ST.spobject at first tries to use xpkmaster.library.
  39.      If this one is not available, it tries powerpacker.library.
  40.      If none of them is available, it simply uses dos.library :
  41.      So, if you read a packed module, although you did not install any
  42.      decompression libraries, please note the following :
  43.      After loading the data is checked, so that modules which could
  44.      not be decompressed are rejected without any further notice.
  45.  
  46.  
  47.   Author
  48.   ~~~~~~
  49.   Andreas R. Kleinert
  50.   Grube Hohe Grethe 23
  51.   D-57074 Siegen
  52.   Germany
  53.  
  54.  
  55.   Credits
  56.   ~~~~~~~
  57.   The "powerpacker.library" V33+ is (C)opyright by Nico François.
  58.   The Library is FREEWARE and is needed by ST.spobject, to be able
  59.   to read and play also PP20-packed Modules.
  60.  
  61.   The "xpkmaster.library" V2+ is (C)opyright by its authors
  62.   (c/o Urban Dominik Müller).
  63.   The Library is freely distributable and is needed by ST.spobject,
  64.   to be able to read and play XPK-packed Modules.
  65.  
  66.   Upto V1.2 the main Player Source-Code in Assembler was taken from
  67.   the Public Domain Library "STReplay" by Oliver Wagner, which can be
  68.   found on AmigaLib-Disk #258.
  69.   Oliver said in the Docs to STReplay, that he did not obtain any rights
  70.   to the Source, so I used it for my own purposes.
  71.   Nevertheless I did not just "include" the Source, but made many - more
  72.   or less useful and important - changes to it.
  73.  
  74.   Since V1.3 the new ProTracker V2.2a Player Routine is used.
  75.   I got it from Gerd Frank (thanks Gerd !) and modified it for my own
  76.   purposes : Some changes had to be made to assemble it with the SAS/C
  77.   ASM V6.5 and to make it living in the multitasking better than before.
  78.   Finally, I had to change and add some more code to create an interface
  79.   to the C-SourceCode of the SPObject's main routines.
  80.  
  81.   Here's an excerpt from the SourceCode as far as concerning the original
  82.   authors (no special copyright notice was found, so it is perhaps
  83.   Public Domain) :
  84.  
  85.   * ProTracker2.2a replay routine by Crayon/Noxious. Improved and modified
  86.   * by Teeme of Fist! Unlimited in 1992. Share and enjoy! :)
  87.   * Rewritten for Devpac (slightly..) by CJ.
  88.  
  89.  
  90.   History
  91.   ~~~~~~~
  92.   V2.2 (11.12.1994) :
  93.  
  94.    - extraction of samples only worked with modules, which had been
  95.      XPK-packed. Now also PP20 or unpacked modules can be handled.
  96.    - fixed internal bug
  97.  
  98.  
  99.   V2.1 (18.07.1994) :
  100.  
  101.    - fixed BAD BUG in file-recognition routine, which may have caused
  102.      this SPObject crashing very often, if
  103.        a) this SPObject was not very late in the list of SPObjects
  104.        b) this SPObject was late in the list, but an unknown
  105.           FileType was selected e.g. in "SuperPlay"
  106.    - integrated new "SampleList"-Functions for exporting more than one
  107.      sample
  108.    - so extraction of samples from modules now is possible
  109.      (see Example-Programs "SampleListDemo" and "SampleListPlay" for
  110.       detailed information on how to use this functions)
  111.  
  112.  
  113.   V1.6 (19.06.1994) :
  114.  
  115.    - added check for Module type "M!K!", which is Noise/ProTracker with
  116.      100 patterns (thanks to Gerd Frank for reporting this)
  117.  
  118.  
  119.   V1.5 (17.05.1994) :
  120.  
  121.    - use of SAS/C V6.51
  122.    - version still reflected 1.3 instead 1.4. Now we're at 1.5 :-)
  123.    - now "MOD" is either accepted to be the filename's prefix
  124.      ("MOD.ModuleName") or suffix ("ModuleName.MOD").
  125.      This is done, because many modules - e.g. those ported from MS-DOS -
  126.      are named so and we have no other method of identifying them.
  127.    - ST.spobject is no longer dependent on xpkmaster.library :
  128.      now we also use powerpacker.library, if available.
  129.      If no decompression library is installed, we simply try dos.library.
  130.      After loading the data is checked, so that modules which could
  131.      not be decompressed are rejected without any further notice.
  132.    - now checks Module-Type of Files and rejects files, which contain
  133.      IDs other than "M.K." or "FLT4" at the specific offset
  134.  
  135.  
  136.   V1.4 (30.04.1994) :
  137.  
  138.    - version still was V1.2 in V1.3, now we reflect V1.4
  139.    - fixed (hopefully) "header not located" problems within memory
  140.      delocation
  141.  
  142.  
  143.   V1.3 (30.03.1994) :
  144.  
  145.    - replaced old ST Player Routine with new ProTracker V2.2a Player Routine
  146.    - added ST-Module structure definition to Headerfile :
  147.      now it is possible to read the file information without
  148.      playing around with Hex-Offsets.
  149.    - used new STHeader-Definition to print out more information
  150.      about the Module, when calling SPL_FileInfoRequest() :
  151.  
  152.       - SongName
  153.       - Module-Type : "M.K.", "FLT4", ...
  154.       - Number of Instruments (determined by checking InstrLength)
  155.       - Names of Instruments and hidden strings (even if more than
  156.         the nominal number)
  157.         This was a little bit tricky sometimes, but now it works with
  158.         all modules without crashing the Amiga !
  159.         Enjoy reading the "hidden messages" of ST-Files and find out
  160.         the authors of previous "no name"-modules.
  161.    - replaced SAS/C's sprintf()-routine with own, RawDoFmt()-based one.
  162.      This saves about 1800 Bytes.
  163.    - now using Utility-Library for integer operations (activated
  164.      SAS/C's UTILLIB option) : this increases 68000-codesize a little
  165.      bit, but increases speed on 68020+ systems
  166.      (should also decrease codesize, but does not ...)
  167.  
  168.  
  169.   V1.2 (25.02.1994) :
  170.  
  171.    - fixed small bug in memory management routines
  172.  
  173.  
  174.   V1.1 (16.01.1994) :
  175.  
  176.    - first version
  177.  
  178.  
  179.   Copyrights
  180.   ~~~~~~~~~~
  181.   Some of the mentioned names or products above may be copyrighted by
  182.   companies or trademarks of companies.
  183.